<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

<html>
<head>
	<title>XML Debugger Plugin Readme</title>
    <style type="text/css">
        BODY {
            font-size : 100%;
        }
        BODY, TD, TH {
            font-family : tahoma, verdana, arial, helvetica, sans-serif;
            font-size : 0.8em;
        }
        H2 {
             font-size : 10pt;
             font-weight : bold;
        }
        A:hover {
            text-decoration : none;
        }
        H1 {
            font-family : tahoma, arial, helvetica, sans-serif;
            font-size : 1.4em;
            font-weight: bold;
            border-bottom : 1px #ccc solid;
            padding-bottom : 2px;
        }

        TT {
            font-family : courier new;
            font-weight : bold;
            color : #060;
        }
        PRE {
            font-family : courier new;
            font-size : 100%;
        }
    </style>
</head>
<body>

<h1>
XML Debugger Plugin Readme
</h1>

<h2>Overview</h2>

<p>
The xml debugger plugin prints XML traffic to the stdout. The plugin will print raw XML as it
was received and sent by the server as well as interpreted XML (i.e. parsed XML). By default the
plugin will only print raw XML.
</p>

<h2>Installation</h2>

<p>Copy xmldebugger.jar into the plugins directory of your Openfire installation. The
plugin will then be automatically deployed. To upgrade to a new version, copy the new
xmldebugger.jar file over the existing file.</p>

<h2>Configuration</h2>

The debugger plugin is configured via Openfire system properties. These can
be configured under Server/Server Manager/System Properties:

<ul>
    <li><tt>plugin.debugger.interpretedAllowed</tt> -- true to print XML packets
        after they were parsed by the server. This only includes incoming traffic. The
        default value is false.</li>
</ul>

<h2>Using the Plugin</h2>

Traffic generated by sessions created after the plugin was installed will be captured and
printed.

</body>
</html>
